home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 351-375 / disk_354 / mxmlib / mxm.doc < prev    next >
Text File  |  1992-05-06  |  33KB  |  2,579 lines
  1.  
  2. mxm.library/PURPOSE                           mxm.library/PURPOSE
  3.  
  4.  
  5.    BACKGROUND  
  6.        mxm.library   was   created   to   support   our  in-house
  7.        development   environment.   It   contains  basic  support
  8.        functions  as  well  as routines frequently used but never
  9.        to  be  found  in  any library. It seems strange that most
  10.        functions  to  be found in mxm.library will be included in
  11.        Kickstart  1.4.  The  contents  of  the  library  were put
  12.        together  from various sources. You will find code derived
  13.        from  'ancient'  Developers'  kit sources, sample routines
  14.        suggested  on  older  public-domain  disks  as well as new
  15.        routines   written   by   us.   Many  different  areas  of
  16.        programming  are  covered  by  mxm.library  routines. Some
  17.        routines   check   gadgets  while  other  deal  with  data
  18.        encryption  or produce sounds. All in all we have tried to
  19.        keep   the  library  as  small  as  possible  and  -  most
  20.        important - reentrant.  
  21.  
  22.    CREDITS  
  23.        The  ikm.c  source  code  was developed by Jimm Mackraz of
  24.        Commodore-Amiga,  Inc.,  Los Gatos.  AllocRem/FreeRem were
  25.        created  from  old  EA  IFF sources.  PopMenu was extended
  26.        from   example   source  code  by  Gambit  Software.   The
  27.        Crc-16-bit  checksumming  routines were created by Stephen
  28.        Satchell and Chuck Forsberg.  
  29.  
  30.    CONTRIBUTIONS  
  31.        If   you   are  interested  in  adding  new  functions  to
  32.        mxm.library  mail  them  to  us  on  disk.  They  will  be
  33.        included in the next library release.  
  34.  
  35.    ADDRESS  
  36.        Olaf Barthel, MXM 
  37.        Brabeckstrasse 35      
  38.        D-3000 Hannover 71     
  39.  
  40.        Federal Republic of Germany    
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60. mxm.library/AllocRem                         mxm.library/AllocRem
  61.  
  62.  
  63.    NAME  
  64.        AllocRem - Allocate a chunk of memory 
  65.  
  66.    SYNOPSIS 
  67.        MemoryBlock = AllocRem(Size Requirements)      
  68.  
  69.    FUNCTION  
  70.        Very  similar  to  AllocMem, AllocRem allocates a chunk of
  71.        memory,  according  to  size and type passed in arguments.
  72.        The  only  difference is that the size of the memory block
  73.        being allocated is remembered.  
  74.  
  75.    INPUTS  
  76.        Size - 
  77.            The number of bytes to allocate.  
  78.        Requirements - 
  79.            Flags   such  as  MEMF_CHIP,  MEMF_FAST,  MEMF_PUBLIC,
  80.            MEMF_CLEAR.  
  81.  
  82.    RESULTS  
  83.        MemoryBlock - 
  84.            A pointer to the allocated chunk of memory or NULL.  
  85.  
  86.    BUGS  
  87.  
  88.    SEE ALSO 
  89.        exec.library/AllocMem exec.library/FreeMem
  90.        mxm.library/AllocRem       
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120. mxm.library/FreeRem                           mxm.library/FreeRem
  121.  
  122.  
  123.    NAME  
  124.        FreeRem - Free a chunk of memory 
  125.  
  126.    SYNOPSIS 
  127.        Pointer = FreeRem(MemoryBlock)       
  128.  
  129.    FUNCTION  
  130.        FreeRem   deallocates   a   block   of  memory  previously
  131.        allocated  by  AllocRem.  The  size  of the block does not
  132.        need  to  specified  since  it  is  stored  in  the  first
  133.        longword  of  the MemoryBlock. This function is quite safe
  134.        since NULL pointers are skipped.  
  135.  
  136.    INPUTS  
  137.        MemoryBlock - 
  138.            Pointer to the chunk of memory to be allocated.  
  139.  
  140.    RESULTS  
  141.        Pointer - 
  142.            This  function  always  returns  NULL,  so user can do
  143.            Pointer = FreeRem(Pointer).  
  144.  
  145.    BUGS  
  146.        FreeRem  cannot be used to deallocate memory allocated via
  147.        AllocMem.  
  148.  
  149.    SEE ALSO 
  150.        exec.library/AllocMem exec.library/FreeMem
  151.        mxm.library/FreeRem       
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180. mxm.library/CreateFuncTask             mxm.library/CreateFuncTask
  181.  
  182.  
  183.    NAME  
  184.        CreateFuncTask - Create a task 
  185.  
  186.    SYNOPSIS 
  187.        Task = CreateFuncTask(TaskName Priority InitialPC
  188.        StackSize)    
  189.  
  190.    FUNCTION  
  191.        CreateFuncTask  creates  a  task from a given function and
  192.        adds  it  to  the  system list. The name of the task to be
  193.        created  does not need to be statically initialized. It is
  194.        copied  into  a separate chunk of memory and gets freed by
  195.        DeleteFuncTask().  
  196.  
  197.    INPUTS  
  198.        TaskName - 
  199.            Pointer to null-terminated string.  
  200.        Priority - 
  201.            The priority the task will be started from.  
  202.        InitialPC - 
  203.            Pointer to function to be started as a task.  
  204.        StackSize - 
  205.            The stack size you wish to execute the task with.  
  206.  
  207.    RESULTS  
  208.        Task - 
  209.            Pointer to a Task-structure, or NULL.  
  210.  
  211.    BUGS  
  212.  
  213.    SEE ALSO 
  214.        exec.library/AddTask         
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240. mxm.library/DeleteFuncTask             mxm.library/DeleteFuncTask
  241.  
  242.  
  243.    NAME  
  244.        DeleteFuncTask - Delete a task 
  245.  
  246.    SYNOPSIS 
  247.        Pointer = DeleteFuncTask(Task)       
  248.  
  249.    FUNCTION  
  250.        DeleteFuncTask   removes  a  Task  from  the  system  list
  251.        previously created with CreateFuncTask.  
  252.  
  253.    INPUTS  
  254.        Task - 
  255.            Pointer to a Task-structure.  
  256.  
  257.    RESULTS  
  258.        This  function always returns NULL, so user can do Pointer
  259.        = DeleteFuncTask(Pointer).  
  260.  
  261.    BUGS  
  262.        This function does not handle self-deletion properly.  
  263.  
  264.    SEE ALSO 
  265.        mxm.library/CreateFuncTask         
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300. mxm.library/CreateFuncProc             mxm.library/CreateFuncProc
  301.  
  302.  
  303.    NAME  
  304.        CreateFuncProc - Create a process 
  305.  
  306.    SYNOPSIS 
  307.        Proc = CreateFuncProc(ProcName Priority InitialPC
  308.        StackSize)    
  309.  
  310.    FUNCTION  
  311.        CreateFuncProc  creates  a  process  from a given function
  312.        and adds it to the system list.  
  313.  
  314.    INPUTS  
  315.        ProcName - 
  316.            Pointer to null-terminated string.  
  317.        Priority - 
  318.            The priority the process will be started from.  
  319.        InitialPC - 
  320.            Pointer to function to be started as a process.  
  321.        StackSize - 
  322.            The stack size you wish to execute the process with.  
  323.  
  324.    RESULTS  
  325.        Proc - 
  326.            Pointer to a Process-structure, or NULL.  
  327.  
  328.    BUGS  
  329.        Currently   this   function   can   only  be  called  from
  330.        processes,  since DOS-routines are employed to install the
  331.        new process.  
  332.  
  333.    SEE ALSO 
  334.        exec.library/AddTask mxm.library/CreateFuncTask        
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360. mxm.library/MovePointer                   mxm.library/MovePointer
  361.  
  362.  
  363.    NAME  
  364.        MovePointer - Move the mouse pointer to given position 
  365.  
  366.    SYNOPSIS 
  367.        Success = MovePointer(Screen Button X Y)    
  368.  
  369.    FUNCTION  
  370.        MovePointer  positions  the mouse pointer at the given x/y
  371.        position   relative  to  the  top/leftedge  of  a  screen.
  372.        Optionally a mouse-click can be simulated.  
  373.  
  374.    INPUTS  
  375.        Screen - 
  376.            Pointer to a Screen-structure.  
  377.        Button - 
  378.            Boolean,   TRUE  if  you  want  a  mouse-click  to  be
  379.            simulated, FALSE if not.  
  380.        X - 
  381.            New X-position for the mouse pointer.  
  382.        Y - 
  383.            New Y-position for the mouse pointer.  
  384.  
  385.    RESULTS  
  386.        Success - 
  387.            Boolean.  
  388.  
  389.    BUGS  
  390.  
  391.    SEE ALSO 
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420. mxm.library/WriteConsole                 mxm.library/WriteConsole
  421.  
  422.  
  423.    NAME  
  424.        WriteConsole - Write a string to a window.  
  425.  
  426.    SYNOPSIS 
  427.        Success = WriteConsole(Window String)      
  428.  
  429.    FUNCTION  
  430.        This  function  behaves  very  much  like  a  call  to the
  431.        ANSI-function  puts().   A  string, which may include ANSI
  432.        control codes, is printed into a window.  
  433.  
  434.    INPUTS  
  435.        Window - 
  436.            Pointer to a Window-structure.  
  437.        String - 
  438.            Pointer to a null-terminated string.  
  439.  
  440.    RESULTS  
  441.        Success - 
  442.            Boolean.  
  443.  
  444.    BUGS  
  445.  
  446.    SEE ALSO 
  447.        ANSI puts() command       
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480. mxm.library/DeletePrinterSupport mxm.library/DeletePrinterSupport
  481.  
  482.  
  483.    NAME  
  484.        DeletePrinterSupport   -   Deallocate   a   PrinterSupport
  485.        request.  
  486.  
  487.    SYNOPSIS 
  488.        Pointer = DeletePrinterSupport(Support)       
  489.  
  490.    FUNCTION  
  491.        All  necessary  cleanups  for the PrinterSupport functions
  492.        are  provided  with  this  function  (allocated  memory is
  493.        freed,   device  actions  stopped  and  device  driver  is
  494.        closed).  
  495.  
  496.    INPUTS  
  497.        Support - 
  498.            Pointer to a PrinterSupport-structure.  
  499.  
  500.    RESULTS  
  501.        This  function always returns NULL, so user can do Pointer
  502.        = DeletePrinterSupport(Pointer).  
  503.  
  504.    BUGS  
  505.  
  506.    SEE ALSO 
  507.        mxm.library/CreatePrinterSupport
  508.        mxm.library/StartPrinterDump
  509.        mxm.library/StopPrinterDump 
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540. mxm.library/CreatePrinterSupport mxm.library/CreatePrinterSupport
  541.  
  542.  
  543.    NAME  
  544.        CreatePrinterSupport          -         Allocate         a
  545.        PrinterSupport-structure  and  prepare the unit driver for
  546.        printing.  
  547.  
  548.    SYNOPSIS 
  549.        Support = CreatePrinterSupport(RastPort ViewPort LeftEdge
  550.        TopEdge Width Height Large) 
  551.  
  552.    FUNCTION  
  553.        This  function  creates  a  Dump-Rastport  request for the
  554.        printer.device  and  passes  it back to the caller who has
  555.        to start the dump by a call to StartPrinterDump().  
  556.  
  557.    INPUTS  
  558.        RastPort - 
  559.            Pointer to a RastPort-structure, area to be printed.  
  560.        ViewPort - 
  561.            Pointer to a ViewPort-structure.  
  562.        LeftEdge/TopEdge - 
  563.            Corner of area to start printing from.  
  564.        Width/Height - 
  565.            Size of area to be printed.  
  566.        Large - 
  567.            Set  this to TRUE if you wish to have the area printed
  568.            as large as possible.  
  569.  
  570.    RESULTS  
  571.        Support   =  Pointer  to  a  PrinterSupport-structure,  or
  572.        NULL.  
  573.  
  574.    BUGS  
  575.  
  576.    SEE ALSO 
  577.        printer.device/PRDDUMPRPORT         
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600. mxm.library/StartPrinterDump         mxm.library/StartPrinterDump
  601.  
  602.  
  603.    NAME  
  604.        StartPrinterDump - Send a graphics dump to the printer.  
  605.  
  606.    SYNOPSIS 
  607.        StartPrinterDump(Support WaitUntilDone)        
  608.  
  609.    FUNCTION  
  610.        A    printer   graphics   dump   following   a   call   to
  611.        CreatePrinterSupport is executed.  
  612.  
  613.    INPUTS  
  614.        Support - 
  615.            Pointer to a PrinterSupport-structure.  
  616.        WaitUntilDone - 
  617.            TRUE  if  you  want the request to be satisfied before
  618.            this function returns.  
  619.  
  620.    RESULTS  
  621.  
  622.    BUGS  
  623.  
  624.    SEE ALSO 
  625.        mxm.library/CreatePrinterSupport
  626.        printer.device/PRDDUMPRPORT        
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660. mxm.library/StopPrinterDump           mxm.library/StopPrinterDump
  661.  
  662.  
  663.    NAME  
  664.        StopPrinterDump   -   Stop   a   graphics  dump  being  in
  665.        progress.  
  666.  
  667.    SYNOPSIS 
  668.        Success = StopPrinterDump(Support WaitUntilDone)      
  669.  
  670.    FUNCTION  
  671.        A  printer  graphics  dump started with StartPrinterDump()
  672.        can be stopped with this function.  
  673.  
  674.    INPUTS  
  675.        Support - 
  676.            Pointer to a PrinterSupport-structure.  
  677.        WaitUntilDone - 
  678.            TRUE  if  you  want  this function to return after the
  679.            AbortIO function has been satisfied.  
  680.  
  681.    RESULTS  
  682.        Success - 
  683.            Boolean,  FALSE if printer graphics dump was not to be
  684.            aborted.  
  685.  
  686.    BUGS  
  687.  
  688.    SEE ALSO 
  689.        mxm.library/CreatePrinterSupport
  690.        mxm.library/StartPrinterSupport,
  691.        printer.device/PRDDUMPRPORT 
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720. mxm.library/DeleteTimer                   mxm.library/DeleteTimer
  721.  
  722.  
  723.    NAME  
  724.        DeleteTimer - Delete a timer-request.  
  725.  
  726.    SYNOPSIS 
  727.        DeleteTimer(TimeRequest)         
  728.  
  729.    FUNCTION  
  730.        This   function   deallocates   a   timer.device   request
  731.        previously allocated via CreateTimer.  
  732.  
  733.    INPUTS  
  734.        TimeRequest - 
  735.            Pointer to a timerequest structure.  
  736.  
  737.    RESULTS  
  738.  
  739.    BUGS  
  740.  
  741.    SEE ALSO 
  742.  
  743.  
  744.  
  745.  
  746.  
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780. mxm.library/CreateTimer                   mxm.library/CreateTimer
  781.  
  782.  
  783.    NAME  
  784.        CreateTimer - Create a timer-request 
  785.  
  786.    SYNOPSIS 
  787.        TimeRequest = CreateTimer(Unit)       
  788.  
  789.    FUNCTION  
  790.        A  timer-request  is created with this function, depending
  791.        on the requested device driver unit.  
  792.  
  793.    INPUTS  
  794.        Unit - 
  795.            The  unit  to  be  opened, can be either UNITVBLANK or
  796.            UNITMICROHZ.  
  797.  
  798.    RESULTS  
  799.        TimeRequest - 
  800.            Pointer to a timerequest-structure, or NULL.  
  801.  
  802.    BUGS  
  803.  
  804.    SEE ALSO 
  805.  
  806.  
  807.  
  808.  
  809.  
  810.  
  811.  
  812.  
  813.  
  814.  
  815.  
  816.  
  817.  
  818.  
  819.  
  820.  
  821.  
  822.  
  823.  
  824.  
  825.  
  826.  
  827.  
  828.  
  829.  
  830.  
  831.  
  832.  
  833.  
  834.  
  835.  
  836.  
  837.  
  838.  
  839.  
  840. mxm.library/WaitForTimer                 mxm.library/WaitForTimer
  841.  
  842.  
  843.    NAME  
  844.        WaitForTimer - Wait a given period of time.  
  845.  
  846.    SYNOPSIS 
  847.        WaitForTimer(TimeRequest TimeVal)        
  848.  
  849.    FUNCTION  
  850.        This  function  gets  the timer.device to wait a period of
  851.        time.  
  852.  
  853.    INPUTS  
  854.        TimeRequest - 
  855.            Pointer to a timerequest-structure.  
  856.        TimeVal - 
  857.            Pointer to a timeval-structure.  
  858.  
  859.    RESULTS  
  860.  
  861.    BUGS  
  862.  
  863.    SEE ALSO 
  864.  
  865.  
  866.  
  867.  
  868.  
  869.  
  870.  
  871.  
  872.  
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882.  
  883.  
  884.  
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900. mxm.library/TimeDelay                       mxm.library/TimeDelay
  901.  
  902.  
  903.    NAME  
  904.        TimeDelay - Wait a given period of time.  
  905.  
  906.    SYNOPSIS 
  907.        TimeDelay(Seconds Micros Unit)       
  908.  
  909.    FUNCTION  
  910.        This  function  gets  the timer.device to wait a period of
  911.        time.  
  912.  
  913.    INPUTS  
  914.        Seconds - 
  915.            Seconds to wait.  
  916.        Micros - 
  917.            Microseconds to wait.  
  918.        Unit - 
  919.            The  unit  to  be  opened, can be either UNITVBLANK or
  920.            UNITMICROHZ.  
  921.  
  922.    RESULTS  
  923.  
  924.    BUGS  
  925.  
  926.    SEE ALSO 
  927.  
  928.  
  929.  
  930.  
  931.  
  932.  
  933.  
  934.  
  935.  
  936.  
  937.  
  938.  
  939.  
  940.  
  941.  
  942.  
  943.  
  944.  
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954.  
  955.  
  956.  
  957.  
  958.  
  959.  
  960. mxm.library/KeyConvert                     mxm.library/KeyConvert
  961.  
  962.  
  963.    NAME  
  964.        KeyConvert - Convert a raw-key to an ANSI character.  
  965.  
  966.    SYNOPSIS 
  967.        Character = KeyConvert(IntuiMesssage)       
  968.  
  969.    FUNCTION  
  970.        This  function  converts  the  contents of an IntuiMessage
  971.        raw-key  event  according  to  the current keymap settings
  972.        into a real ANSI-character.  
  973.  
  974.    INPUTS  
  975.        IntuiMessage - 
  976.            Pointer to IntuiMessage-structure.  
  977.  
  978.    RESULTS  
  979.        Character - 
  980.            ANSI character, or NULL.  
  981.  
  982.    BUGS  
  983.  
  984.    SEE ALSO 
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.  
  999.  
  1000.  
  1001.  
  1002.  
  1003.  
  1004.  
  1005.  
  1006.  
  1007.  
  1008.  
  1009.  
  1010.  
  1011.  
  1012.  
  1013.  
  1014.  
  1015.  
  1016.  
  1017.  
  1018.  
  1019.  
  1020. mxm.library/InvertKey                       mxm.library/InvertKey
  1021.  
  1022.  
  1023.    NAME  
  1024.        InvertKey   -   Convert   an   ANSI   character   into  an
  1025.        InputEvent.  
  1026.  
  1027.    SYNOPSIS 
  1028.        Event = InvertKey(Code Event Command ExtraInfo)    
  1029.  
  1030.    FUNCTION  
  1031.        This  function  turns an ANSI character into an InputEvent
  1032.        structure  which  can  be  used  to  feed it back into the
  1033.        stream of input events.  
  1034.  
  1035.    INPUTS  
  1036.        Code - 
  1037.            ANSI character to be converted.  
  1038.        Event - 
  1039.            Pointer to InputEvent-structure.  
  1040.        Command - 
  1041.            A  combination  of  the flags IK_BUILDLIST, IK_USEIKM,
  1042.            IK_USELIST or IK_NOSPECIAL.  
  1043.        ExtraInfo - 
  1044.            This flag should be set to zero.  
  1045.  
  1046.    RESULTS  
  1047.        Event - 
  1048.            Pointer back to input argument, or NULL.  
  1049.  
  1050.    BUGS  
  1051.  
  1052.    SEE ALSO 
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.  
  1078.  
  1079.  
  1080. mxm.library/EraseGadget                   mxm.library/EraseGadget
  1081.  
  1082.  
  1083.    NAME  
  1084.        EraseGadget - Clear the background of a gadget.  
  1085.  
  1086.    SYNOPSIS 
  1087.        EraseGadget(RastPort Gadget Colour)       
  1088.  
  1089.    FUNCTION  
  1090.        The imagery of gadget is erased with this function.  
  1091.  
  1092.    INPUTS  
  1093.        RastPort - 
  1094.            Pointer  to  the RastPort-structure the gadget will be
  1095.            erased from.  
  1096.        Gadget - 
  1097.            Pointer to a Gadget-structure.  
  1098.        Colour - 
  1099.            The pen number to erase the Gadget imagery with.  
  1100.  
  1101.    RESULT  
  1102.        The gadget's imagery is erased.  
  1103.  
  1104.    BUGS  
  1105.  
  1106.    SEE ALSO 
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.  
  1120.  
  1121.  
  1122.  
  1123.  
  1124.  
  1125.  
  1126.  
  1127.  
  1128.  
  1129.  
  1130.  
  1131.  
  1132.  
  1133.  
  1134.  
  1135.  
  1136.  
  1137.  
  1138.  
  1139.  
  1140. mxm.library/RefreshGadget               mxm.library/RefreshGadget
  1141.  
  1142.  
  1143.    NAME  
  1144.        RefreshGadget - Refresh a single Gadget.  
  1145.  
  1146.    SYNOPSIS 
  1147.        RefreshGadget(Gadget Window)        
  1148.  
  1149.    FUNCTION  
  1150.        This  function  refreshes  a  single gadget, not the whole
  1151.        list.  
  1152.  
  1153.    INPUTS  
  1154.        Gadget - 
  1155.            Pointer to a Gadget-structure.  
  1156.        Window - 
  1157.            Pointer to a Window-structure.  
  1158.  
  1159.    RESULTS  
  1160.        The gaget's imagery gets redrawn.  
  1161.  
  1162.    BUGS  
  1163.  
  1164.    SEE ALSO 
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.  
  1196.  
  1197.  
  1198.  
  1199.  
  1200. mxm.library/GetLongInt                     mxm.library/GetLongInt
  1201.  
  1202.  
  1203.    NAME  
  1204.        GetLongInt - Get a value from a long integer gadget.  
  1205.  
  1206.    SYNOPSIS 
  1207.        Value = GetLongInt(Gadget)       
  1208.  
  1209.    FUNCTION  
  1210.        This  function  returns the value currently displayed in a
  1211.        long integer gadget.  
  1212.  
  1213.    INPUTS  
  1214.        Gadget - 
  1215.            Pointer to a Gadget-structure.  
  1216.  
  1217.    RESULTS  
  1218.        Value - 
  1219.            The long integer value.  
  1220.  
  1221.    BUGS  
  1222.  
  1223.    SEE ALSO 
  1224.  
  1225.  
  1226.  
  1227.  
  1228.  
  1229.  
  1230.  
  1231.  
  1232.  
  1233.  
  1234.  
  1235.  
  1236.  
  1237.  
  1238.  
  1239.  
  1240.  
  1241.  
  1242.  
  1243.  
  1244.  
  1245.  
  1246.  
  1247.  
  1248.  
  1249.  
  1250.  
  1251.  
  1252.  
  1253.  
  1254.  
  1255.  
  1256.  
  1257.  
  1258.  
  1259.  
  1260. mxm.library/SetLongInt                     mxm.library/SetLongInt
  1261.  
  1262.  
  1263.    NAME  
  1264.        SetLongInt - Set the value of a long integer gadget.  
  1265.  
  1266.    SYNOPSIS 
  1267.        SetLongInt(Gadget Val)        
  1268.  
  1269.    FUNCTION  
  1270.        This  function  sets  the  value to be displayed in a long
  1271.        integer gadget.  
  1272.  
  1273.    INPUTS  
  1274.        Gadget - 
  1275.            Pointer to a Gadget-structure.  
  1276.        Val - 
  1277.            Long integer value to be put into the gadget.  
  1278.  
  1279.    RESULTS  
  1280.  
  1281.    BUGS  
  1282.        The  Gadget  has to be refreshed to actually see the value
  1283.        displayed.  
  1284.  
  1285.    SEE ALSO 
  1286.  
  1287.  
  1288.  
  1289.  
  1290.  
  1291.  
  1292.  
  1293.  
  1294.  
  1295.  
  1296.  
  1297.  
  1298.  
  1299.  
  1300.  
  1301.  
  1302.  
  1303.  
  1304.  
  1305.  
  1306.  
  1307.  
  1308.  
  1309.  
  1310.  
  1311.  
  1312.  
  1313.  
  1314.  
  1315.  
  1316.  
  1317.  
  1318.  
  1319.  
  1320. mxm.library/GetGadgetString           mxm.library/GetGadgetString
  1321.  
  1322.  
  1323.    NAME  
  1324.        GetGadgetString - Get a string from a string gadget.  
  1325.  
  1326.    SYNOPSIS 
  1327.        String = GetGadgetString(Gadget)       
  1328.  
  1329.    FUNCTION  
  1330.        This  function  returns  a  pointer  to  the  ASCII-string
  1331.        buffer of a string gadget.  
  1332.  
  1333.    INPUTS  
  1334.        Gadget - 
  1335.            Pointer to a Gadget-structure.  
  1336.  
  1337.    RESULTS  
  1338.        String - 
  1339.            Pointer to an unsigned char (UBYTE).  
  1340.  
  1341.    BUGS  
  1342.  
  1343.    SEE ALSO 
  1344.  
  1345.  
  1346.  
  1347.  
  1348.  
  1349.  
  1350.  
  1351.  
  1352.  
  1353.  
  1354.  
  1355.  
  1356.  
  1357.  
  1358.  
  1359.  
  1360.  
  1361.  
  1362.  
  1363.  
  1364.  
  1365.  
  1366.  
  1367.  
  1368.  
  1369.  
  1370.  
  1371.  
  1372.  
  1373.  
  1374.  
  1375.  
  1376.  
  1377.  
  1378.  
  1379.  
  1380. mxm.library/SetGadgetString           mxm.library/SetGadgetString
  1381.  
  1382.  
  1383.    NAME  
  1384.        SetGadgetString - Set the string for a string gadget.  
  1385.  
  1386.    SYNOPSIS 
  1387.        SetGadgetString(Gadget String)        
  1388.  
  1389.    FUNCTION  
  1390.        This  function sets the string to be displayed in a string
  1391.        gadget.  
  1392.  
  1393.    INPUTS  
  1394.        Gadget - 
  1395.            Pointer to a Gadget-structure.  
  1396.        String - 
  1397.            Pointer  to  an  unsigned char (UBYTE), i.e. String to
  1398.            be set.  
  1399.  
  1400.    RESULTS  
  1401.  
  1402.    BUGS  
  1403.        The  Gadget has to be refreshed to actually see the string
  1404.        displayed.  
  1405.  
  1406.    SEE ALSO 
  1407.  
  1408.  
  1409.  
  1410.  
  1411.  
  1412.  
  1413.  
  1414.  
  1415.  
  1416.  
  1417.  
  1418.  
  1419.  
  1420.  
  1421.  
  1422.  
  1423.  
  1424.  
  1425.  
  1426.  
  1427.  
  1428.  
  1429.  
  1430.  
  1431.  
  1432.  
  1433.  
  1434.  
  1435.  
  1436.  
  1437.  
  1438.  
  1439.  
  1440. mxm.library/GetToggleGadget           mxm.library/GetToggleGadget
  1441.  
  1442.  
  1443.    NAME  
  1444.        GetToggleGadget - Get the state of a Bool-Gadget.  
  1445.  
  1446.    SYNOPSIS 
  1447.        State = GetToggleGadget(Gadget)       
  1448.  
  1449.    FUNCTION  
  1450.        This  function  returns  the  state of a Bool-Gadget which
  1451.        has    the    TOGGLEGADGET    flags   set   and   can   be
  1452.        selected/unselected.  
  1453.  
  1454.    INPUTS  
  1455.        Gadget - 
  1456.            Pointer to a Gadget-structure.  
  1457.  
  1458.    RESULTS  
  1459.        State - 
  1460.            Boolean  value,  TRUE  if gadget is selected, false if
  1461.            otherwise.  
  1462.  
  1463.    BUGS  
  1464.  
  1465.    SEE ALSO 
  1466.  
  1467.  
  1468.  
  1469.  
  1470.  
  1471.  
  1472.  
  1473.  
  1474.  
  1475.  
  1476.  
  1477.  
  1478.  
  1479.  
  1480.  
  1481.  
  1482.  
  1483.  
  1484.  
  1485.  
  1486.  
  1487.  
  1488.  
  1489.  
  1490.  
  1491.  
  1492.  
  1493.  
  1494.  
  1495.  
  1496.  
  1497.  
  1498.  
  1499.  
  1500. mxm.library/SetToggleGadget           mxm.library/SetToggleGadget
  1501.  
  1502.  
  1503.    NAME  
  1504.        SetToggleGadget - Set the state of a Bool-Gadget.  
  1505.  
  1506.    SYNOPSIS 
  1507.        SetToggleGadget(Gadget State)        
  1508.  
  1509.    FUNCTION  
  1510.        This  function  sets  the  select  state  of a Bool-Gadget
  1511.        which   has   the   TOGGLEGADGET  flags  set  and  can  be
  1512.        selected/unselected.  
  1513.  
  1514.    INPUTS  
  1515.        Gadget - 
  1516.            Pointer to a Gadget-structure.  
  1517.        State - 
  1518.            Boolean,  TRUE  if  gadget is to be selected, FALSE if
  1519.            otherwise.  
  1520.  
  1521.    RESULTS  
  1522.  
  1523.    BUGS  
  1524.        The  Gadget  has to be refreshed to actually see the state
  1525.        displayed.  
  1526.  
  1527.    SEE ALSO 
  1528.  
  1529.  
  1530.  
  1531.  
  1532.  
  1533.  
  1534.  
  1535.  
  1536.  
  1537.  
  1538.  
  1539.  
  1540.  
  1541.  
  1542.  
  1543.  
  1544.  
  1545.  
  1546.  
  1547.  
  1548.  
  1549.  
  1550.  
  1551.  
  1552.  
  1553.  
  1554.  
  1555.  
  1556.  
  1557.  
  1558.  
  1559.  
  1560. mxm.library/SetWaitPointer             mxm.library/SetWaitPointer
  1561.  
  1562.  
  1563.    NAME  
  1564.        SetWaitPointer - Change the pointer to a Zzz-Balloon.  
  1565.  
  1566.    SYNOPSIS 
  1567.        SetWaitPointer(Window)         
  1568.  
  1569.    FUNCTION  
  1570.        This  function  changes  the  mouse pointer of a window to
  1571.        the   standard   Workbench-Balloon,  indicating  that  the
  1572.        running task is busy.  
  1573.  
  1574.    INPUTS  
  1575.        Window - 
  1576.            Pointer to a Window-structure.  
  1577.  
  1578.    RESULTS  
  1579.        The mouse pointer gets changed.  
  1580.  
  1581.    BUGS  
  1582.  
  1583.    SEE ALSO 
  1584.  
  1585.  
  1586.  
  1587.  
  1588.  
  1589.  
  1590.  
  1591.  
  1592.  
  1593.  
  1594.  
  1595.  
  1596.  
  1597.  
  1598.  
  1599.  
  1600.  
  1601.  
  1602.  
  1603.  
  1604.  
  1605.  
  1606.  
  1607.  
  1608.  
  1609.  
  1610.  
  1611.  
  1612.  
  1613.  
  1614.  
  1615.  
  1616.  
  1617.  
  1618.  
  1619.  
  1620. mxm.library/PopRequest                     mxm.library/PopRequest
  1621.  
  1622.  
  1623.    NAME  
  1624.        PopRequest - Display a pop-up-requester.  
  1625.  
  1626.    SYNOPSIS 
  1627.        Result = PopRequest(ParentWindow TitleText BodyText
  1628.        PosText NegText Default ExtraInfo) 
  1629.  
  1630.    FUNCTION  
  1631.        This  function  brings  up  a  pop-up-requester  which  is
  1632.        automatically   centered  under  the  mouse  pointer.  The
  1633.        requester   can   be   answered  via  keyboard,  supported
  1634.        positive  keys  are:  Y, J, V, C, R, Return; negative keys
  1635.        are:  N,  Q,  B, Escape. Having answered the requester the
  1636.        original front screen is brought to the front again.  
  1637.  
  1638.    INPUTS  
  1639.        ParentWindow - 
  1640.            Pointer  to  a  Window structure in which you want the
  1641.            requester  to  appear,  may be NULL, so requester will
  1642.            appear on the Workbench screen.  
  1643.        TitleText - 
  1644.            The  title  of  the  requester window, may be NULL, so
  1645.            "System Request:" will be used.  
  1646.        BodyText - 
  1647.            The   text   you  want  to  be  displayed  inside  the
  1648.            requester    may    include   ANSI-control   sequences
  1649.            (boldface, italics, different colours, etc.) 
  1650.        PosText - 
  1651.            Text  for  positive  response  Gadget,  may be NULL in
  1652.            which case no positive Gadget will be displayed.  
  1653.        NegText - 
  1654.            Tetx  for  negative  response  Gadget,  may be NULL in
  1655.            which  case  no  negative  Gadget  will  be displayed.
  1656.            PosText  & NegText being NULL, NegText will default to
  1657.            "Okay".  
  1658.        Default - 
  1659.            Boolean  value  indicating  the default value expected
  1660.            from the requester.  
  1661.        ExtraInfo - 
  1662.            Pointer to a PopSupport structure.  
  1663.  
  1664.    RESULTS  
  1665.        Result - 
  1666.            Boolean, depending on the gadget being selected.  
  1667.  
  1668.    BUGS  
  1669.  
  1670.    SEE ALSO 
  1671.        mxmbase.h/struct PopSupport        
  1672.  
  1673.  
  1674.  
  1675.  
  1676.  
  1677.  
  1678.  
  1679.  
  1680. mxm.library/PopMenu                           mxm.library/PopMenu
  1681.  
  1682.  
  1683.    NAME  
  1684.        PopMenu - Display a pop-up-menu.  
  1685.  
  1686.    SYNOPSIS 
  1687.        Item = PopMenu(Menu Window)      
  1688.  
  1689.    FUNCTION  
  1690.        This  function  displays  a  menu,  very  similar  to  the
  1691.        standard Intuition menus, just under the mouse pointer.  
  1692.  
  1693.    INPUTS  
  1694.        Menu - 
  1695.            Pointer to a Menu-structure.  
  1696.        Window - 
  1697.            Pointer to a Window-structure.  
  1698.  
  1699.    RESULTS  
  1700.        The menu item selected, or -1 if no item was selected.  
  1701.  
  1702.    BUGS  
  1703.        PopMenu   does   not   handle  sub-items  in  the  current
  1704.        release.  
  1705.  
  1706.    SEE ALSO 
  1707.        mxmbase.h         
  1708.  
  1709.  
  1710.  
  1711.  
  1712.  
  1713.  
  1714.  
  1715.  
  1716.  
  1717.  
  1718.  
  1719.  
  1720.  
  1721.  
  1722.  
  1723.  
  1724.  
  1725.  
  1726.  
  1727.  
  1728.  
  1729.  
  1730.  
  1731.  
  1732.  
  1733.  
  1734.  
  1735.  
  1736.  
  1737.  
  1738.  
  1739.  
  1740. mxm.library/Announce                         mxm.library/Announce
  1741.  
  1742.  
  1743.    NAME  
  1744.        Announce - Produce an audible signal.  
  1745.  
  1746.    SYNOPSIS 
  1747.        Announce()         
  1748.  
  1749.    FUNCTION  
  1750.        Announce  produces a sound, not a beep but a chime, on two
  1751.        stereo channels.  
  1752.  
  1753.    INPUTS  
  1754.  
  1755.    RESULTS  
  1756.  
  1757.    BUGS  
  1758.  
  1759.    SEE ALSO 
  1760.  
  1761.  
  1762.  
  1763.  
  1764.  
  1765.  
  1766.  
  1767.  
  1768.  
  1769.  
  1770.  
  1771.  
  1772.  
  1773.  
  1774.  
  1775.  
  1776.  
  1777.  
  1778.  
  1779.  
  1780.  
  1781.  
  1782.  
  1783.  
  1784.  
  1785.  
  1786.  
  1787.  
  1788.  
  1789.  
  1790.  
  1791.  
  1792.  
  1793.  
  1794.  
  1795.  
  1796.  
  1797.  
  1798.  
  1799.  
  1800. mxm.library/CheckSumCRC                   mxm.library/CheckSumCRC
  1801.  
  1802.  
  1803.    NAME  
  1804.        CheckSumCRC  -  Calculate  the  16-bit  crc checksum for a
  1805.        memory block.  
  1806.  
  1807.    SYNOPSIS 
  1808.        CRC = CheckSumCRC(Mem Size)      
  1809.  
  1810.    FUNCTION  
  1811.        This  function  uses the Satchell/Forsberg-crc-function to
  1812.        calculate  the  16-bit  checksum  for  a memory block with
  1813.        given size.  
  1814.  
  1815.    INPUTS  
  1816.        Mem - 
  1817.            Pointer to memory block to be checksummed.  
  1818.        Size - 
  1819.            Size of the memory block to be checksummed.  
  1820.  
  1821.    RESULTS  
  1822.        CRC - 
  1823.            The 16-bit crc value for the memory block.  
  1824.  
  1825.    BUGS  
  1826.  
  1827.    SEE ALSO 
  1828.  
  1829.  
  1830.  
  1831.  
  1832.  
  1833.  
  1834.  
  1835.  
  1836.  
  1837.  
  1838.  
  1839.  
  1840.  
  1841.  
  1842.  
  1843.  
  1844.  
  1845.  
  1846.  
  1847.  
  1848.  
  1849.  
  1850.  
  1851.  
  1852.  
  1853.  
  1854.  
  1855.  
  1856.  
  1857.  
  1858.  
  1859.  
  1860. mxm.library/CheckSumSimple             mxm.library/CheckSumSimple
  1861.  
  1862.  
  1863.    NAME  
  1864.        CheckSum  -  Calculate  a  simple  checksum  for  a memory
  1865.        block.  
  1866.  
  1867.    SYNOPSIS 
  1868.        Check = CheckSum(Mem Size)      
  1869.  
  1870.    FUNCTION  
  1871.        Similar   to   CheckSumCRC   this  function  calculates  a
  1872.        checksum   for   a  memory  block  with  given  size.  The
  1873.        algorithm employed is simpler.  
  1874.  
  1875.    INPUTS  
  1876.        Mem - 
  1877.            Pointer to memory block to be checksummed.  
  1878.        Size - 
  1879.            Size of the memory block to be checksummed.  
  1880.  
  1881.    RESULTS  
  1882.        Check - 
  1883.            The 32-bit checksum value for the memory block.  
  1884.  
  1885.    BUGS  
  1886.  
  1887.    SEE ALSO 
  1888.        mxm.library/CheckSumCRC         
  1889.  
  1890.  
  1891.  
  1892.  
  1893.  
  1894.  
  1895.  
  1896.  
  1897.  
  1898.  
  1899.  
  1900.  
  1901.  
  1902.  
  1903.  
  1904.  
  1905.  
  1906.  
  1907.  
  1908.  
  1909.  
  1910.  
  1911.  
  1912.  
  1913.  
  1914.  
  1915.  
  1916.  
  1917.  
  1918.  
  1919.  
  1920. mxm.library/CryptBlock                     mxm.library/CryptBlock
  1921.  
  1922.  
  1923.    NAME  
  1924.        CryptBlock - Encrypt/Decrypt a memory block.  
  1925.  
  1926.    SYNOPSIS 
  1927.        CryptBlock(Mem Size String)       
  1928.  
  1929.    FUNCTION  
  1930.        This  function encrypts/decrypts a block of memory using a
  1931.        pseudo-random  number  generator. The data is XOR encoded,
  1932.        so  a  double  CryptBlock will result in decryption of the
  1933.        memory  block.  Additionally  a  string  can  be used as a
  1934.        second  encryption  key. The string is optional and can be
  1935.        left out.  
  1936.  
  1937.    INPUTS  
  1938.        Mem - 
  1939.            Pointer to memory block to be checksummed.  
  1940.        Size - 
  1941.            Size of the memory block to be checksummed.  
  1942.        String - 
  1943.            Pointer to second encryption string, may be null.  
  1944.  
  1945.    RESULTS  
  1946.  
  1947.    BUGS  
  1948.  
  1949.    SEE ALSO 
  1950.  
  1951.  
  1952.  
  1953.  
  1954.  
  1955.  
  1956.  
  1957.  
  1958.  
  1959.  
  1960.  
  1961.  
  1962.  
  1963.  
  1964.  
  1965.  
  1966.  
  1967.  
  1968.  
  1969.  
  1970.  
  1971.  
  1972.  
  1973.  
  1974.  
  1975.  
  1976.  
  1977.  
  1978.  
  1979.  
  1980. mxm.library/IsASCII                           mxm.library/IsASCII
  1981.  
  1982.  
  1983.    NAME  
  1984.        IsASCII  -  Check  if  a  character is a valid Amiga ASCII
  1985.        character.  
  1986.  
  1987.    SYNOPSIS 
  1988.        IsIt = IsASCII(Character)       
  1989.  
  1990.    FUNCTION  
  1991.        This  function  checks  if a character belongs to the list
  1992.        of  valid  Amiga ASCII characters.  Unlike compiler macros
  1993.        the   international   character   set   of  the  Amiga  is
  1994.        considered.  
  1995.  
  1996.    INPUTS  
  1997.        Character - 
  1998.            The character to be checked.  
  1999.  
  2000.    RESULTS  
  2001.        IsIt - 
  2002.            Boolean,  TRUE  if  Character  is  a valid Amiga ASCII
  2003.            character.  
  2004.  
  2005.    BUGS  
  2006.  
  2007.    SEE ALSO 
  2008.        toupper() macro        
  2009.  
  2010.  
  2011.  
  2012.  
  2013.  
  2014.  
  2015.  
  2016.  
  2017.  
  2018.  
  2019.  
  2020.  
  2021.  
  2022.  
  2023.  
  2024.  
  2025.  
  2026.  
  2027.  
  2028.  
  2029.  
  2030.  
  2031.  
  2032.  
  2033.  
  2034.  
  2035.  
  2036.  
  2037.  
  2038.  
  2039.  
  2040. mxm.library/IsPrintable                   mxm.library/IsPrintable
  2041.  
  2042.  
  2043.    NAME  
  2044.        IsPrintable  -  Check  if a character is a printable Amiga
  2045.        ASCII character.  
  2046.  
  2047.    SYNOPSIS 
  2048.        IsIt = IsPrintable(Character)       
  2049.  
  2050.    FUNCTION  
  2051.        This  function  checks  if  a character produces a visible
  2052.        result   if   printed.    Unlike   compiler   macros   the
  2053.        international character set of the Amiga is considered.  
  2054.  
  2055.    INPUTS  
  2056.        Character - 
  2057.            The character to be checked.  
  2058.  
  2059.    RESULTS  
  2060.        IsIt - 
  2061.            Boolean,  TRUE  if  Character  is  a valid Amiga ASCII
  2062.            character.  
  2063.  
  2064.    BUGS  
  2065.  
  2066.    SEE ALSO 
  2067.        isprintable() macro        
  2068.  
  2069.  
  2070.  
  2071.  
  2072.  
  2073.  
  2074.  
  2075.  
  2076.  
  2077.  
  2078.  
  2079.  
  2080.  
  2081.  
  2082.  
  2083.  
  2084.  
  2085.  
  2086.  
  2087.  
  2088.  
  2089.  
  2090.  
  2091.  
  2092.  
  2093.  
  2094.  
  2095.  
  2096.  
  2097.  
  2098.  
  2099.  
  2100. mxm.library/ToUpper                           mxm.library/ToUpper
  2101.  
  2102.  
  2103.    NAME  
  2104.        ToUpper - Change a character to upper case.  
  2105.  
  2106.    SYNOPSIS 
  2107.        NewCharacter = ToUpper(Character)       
  2108.  
  2109.    FUNCTION  
  2110.        This  function  turns  a  character  into  an  upper  case
  2111.        character.   Unlike   compiler  macros  the  international
  2112.        character set of the Amiga is considered.  
  2113.  
  2114.    INPUTS  
  2115.        Character - 
  2116.            The character to be turned to upper case.  
  2117.  
  2118.    RESULTS  
  2119.        NewCharacter - 
  2120.            The upper case equivalent to the input character.  
  2121.  
  2122.    BUGS  
  2123.  
  2124.    SEE ALSO 
  2125.        toupper() macro        
  2126.  
  2127.  
  2128.  
  2129.  
  2130.  
  2131.  
  2132.  
  2133.  
  2134.  
  2135.  
  2136.  
  2137.  
  2138.  
  2139.  
  2140.  
  2141.  
  2142.  
  2143.  
  2144.  
  2145.  
  2146.  
  2147.  
  2148.  
  2149.  
  2150.  
  2151.  
  2152.  
  2153.  
  2154.  
  2155.  
  2156.  
  2157.  
  2158.  
  2159.  
  2160. mxm.library/UStrCmp                           mxm.library/UStrCmp
  2161.  
  2162.  
  2163.    NAME  
  2164.        UStrCmp - Case insensitive strcmp().  
  2165.  
  2166.    SYNOPSIS 
  2167.        Difference = UStrCmp(Source Target)      
  2168.  
  2169.    FUNCTION  
  2170.        This  function  does  a  strcmp(), character by character,
  2171.        and   uses   the   ToUpper()   function   to  compare  the
  2172.        characters.    It    also    matches    lower/upper   case
  2173.        international characters.  
  2174.  
  2175.    INPUTS  
  2176.        Source - 
  2177.            Pointer to source string.  
  2178.        Target - 
  2179.            Pointer to target string.  
  2180.  
  2181.    RESULTS  
  2182.        Difference - 
  2183.            The  Difference  between the strings to be compared, 0
  2184.            if no difference.  
  2185.  
  2186.    BUGS  
  2187.  
  2188.    SEE ALSO 
  2189.        mxm.library/ToUpper()         
  2190.  
  2191.  
  2192.  
  2193.  
  2194.  
  2195.  
  2196.  
  2197.  
  2198.  
  2199.  
  2200.  
  2201.  
  2202.  
  2203.  
  2204.  
  2205.  
  2206.  
  2207.  
  2208.  
  2209.  
  2210.  
  2211.  
  2212.  
  2213.  
  2214.  
  2215.  
  2216.  
  2217.  
  2218.  
  2219.  
  2220. mxm.library/Random                             mxm.library/Random
  2221.  
  2222.  
  2223.    NAME  
  2224.        Random - Generate a random value.  
  2225.  
  2226.    SYNOPSIS 
  2227.        Value = Random(MaxValue)       
  2228.  
  2229.    FUNCTION  
  2230.        Random  returns a random value between 0 and MaxValue - 1.
  2231.        The  random  seed  is  XORed  with  the current video beam
  2232.        position,  so  the  random  value  is  guaranteed  not  to
  2233.        produce repeated sequences of pseudo-random values.  
  2234.  
  2235.    INPUTS  
  2236.        MaxValue - 
  2237.            The maximum value + 1 expected from this function.  
  2238.  
  2239.    RESULTS  
  2240.        Value - 
  2241.            Random value.  
  2242.  
  2243.    BUGS  
  2244.  
  2245.    SEE ALSO 
  2246.  
  2247.  
  2248.  
  2249.  
  2250.  
  2251.  
  2252.  
  2253.  
  2254.  
  2255.  
  2256.  
  2257.  
  2258.  
  2259.  
  2260.  
  2261.  
  2262.  
  2263.  
  2264.  
  2265.  
  2266.  
  2267.  
  2268.  
  2269.  
  2270.  
  2271.  
  2272.  
  2273.  
  2274.  
  2275.  
  2276.  
  2277.  
  2278.  
  2279.  
  2280. mxm.library/FindFileWindow             mxm.library/FindFileWindow
  2281.  
  2282.  
  2283.    NAME  
  2284.        FindFileWindow   -  Find  the  window  associated  with  a
  2285.        FileHandle.  
  2286.  
  2287.    SYNOPSIS 
  2288.        Window = FindFileWindow(Handle)       
  2289.  
  2290.    FUNCTION  
  2291.        This  function  finds the Intuition window associated with
  2292.        a  Console  FileHandle  by  passing  the  handler task a a
  2293.        request to identify its volume node (i.e.: the Window).  
  2294.  
  2295.    INPUTS  
  2296.        Handle - 
  2297.            BPTR to a FileHandle-structure.  
  2298.  
  2299.    RESULTS  
  2300.        Window - 
  2301.            Pointer to a Window-structure.  
  2302.  
  2303.    BUGS  
  2304.        This  function will produce garbage if used on non-console
  2305.        FileHandles.  
  2306.  
  2307.    SEE ALSO 
  2308.  
  2309.  
  2310.  
  2311.  
  2312.  
  2313.  
  2314.  
  2315.  
  2316.  
  2317.  
  2318.  
  2319.  
  2320.  
  2321.  
  2322.  
  2323.  
  2324.  
  2325.  
  2326.  
  2327.  
  2328.  
  2329.  
  2330.  
  2331.  
  2332.  
  2333.  
  2334.  
  2335.  
  2336.  
  2337.  
  2338.  
  2339.  
  2340. mxm.library/DeleteHiddenRPort       mxm.library/DeleteHiddenRPort
  2341.  
  2342.  
  2343.    NAME  
  2344.        DeleteHiddenRPort  -  Delete  a hidden RastPort created by
  2345.        CreateHiddenRPort().  
  2346.  
  2347.    SYNOPSIS 
  2348.        Pointer = DeleteHiddenRPort(RastPort)       
  2349.  
  2350.    FUNCTION  
  2351.        This  function  deallocates  a  hidden RastPort previously
  2352.        created with CreateHiddenRPort().  
  2353.  
  2354.    INPUTS  
  2355.        RastPort - 
  2356.            Pointer to a RastPort-structure.  
  2357.  
  2358.    RESULTS  
  2359.        This  function always returns NULL, so user can do Pointer
  2360.        = DeleteHiddenRPort(Pointer).  
  2361.  
  2362.    BUGS  
  2363.  
  2364.    SEE ALSO 
  2365.  
  2366.  
  2367.  
  2368.  
  2369.  
  2370.  
  2371.  
  2372.  
  2373.  
  2374.  
  2375.  
  2376.  
  2377.  
  2378.  
  2379.  
  2380.  
  2381.  
  2382.  
  2383.  
  2384.  
  2385.  
  2386.  
  2387.  
  2388.  
  2389.  
  2390.  
  2391.  
  2392.  
  2393.  
  2394.  
  2395.  
  2396.  
  2397.  
  2398.  
  2399.  
  2400. mxm.library/CreateHiddenRPort       mxm.library/CreateHiddenRPort
  2401.  
  2402.  
  2403.    NAME  
  2404.        CreateHiddenRPort - Create a hidden RastPort.  
  2405.  
  2406.    SYNOPSIS 
  2407.        RastPort = CreateHiddenRPort(Width Height Depth)     
  2408.  
  2409.    FUNCTION  
  2410.        This  function  allocates  a  RastPort structure, a BitMap
  2411.        structure,  initializes them and adds the requested number
  2412.        of  planes to the BitMap. The planes are zeroed out before
  2413.        this function returns.  
  2414.  
  2415.    INPUTS  
  2416.        Width - 
  2417.            Width of the RastPort.  
  2418.        Height - 
  2419.            Height of the RastPort.  
  2420.        Depth - 
  2421.            Depth of the RastPort.  
  2422.  
  2423.    RESULTS  
  2424.        RastPort - 
  2425.            Pointer to a RastPort structure, or NULL.  
  2426.  
  2427.    BUGS  
  2428.  
  2429.    SEE ALSO 
  2430.  
  2431.  
  2432.  
  2433.  
  2434.  
  2435.  
  2436.  
  2437.  
  2438.  
  2439.  
  2440.  
  2441.  
  2442.  
  2443.  
  2444.  
  2445.  
  2446.  
  2447.  
  2448.  
  2449.  
  2450.  
  2451.  
  2452.  
  2453.  
  2454.  
  2455.  
  2456.  
  2457.  
  2458.  
  2459.  
  2460. mxm.library/EnableWindow                 mxm.library/EnableWindow
  2461.  
  2462.  
  2463.    NAME  
  2464.        EnableWindow  - Enable all gadgets of a window and restore
  2465.        the mouse pointer.  
  2466.  
  2467.    SYNOPSIS 
  2468.        EnableWindow(Window)         
  2469.  
  2470.    FUNCTION  
  2471.        This   function   reenables   the   gadgets  of  a  window
  2472.        previously  disabled  with  DisableWindow()  and  sets the
  2473.        standard system mouse pointer.  
  2474.  
  2475.    INPUTS  
  2476.        Window - 
  2477.            The Window to be reenabled.  
  2478.  
  2479.    RESULTS  
  2480.  
  2481.    BUGS  
  2482.        Can    only    handle    windows   really   disabled   via
  2483.        DisableWindow(), may crash on other windows.  
  2484.  
  2485.    SEE ALSO 
  2486.        mxm.library/DisableWindow()         
  2487.  
  2488.  
  2489.  
  2490.  
  2491.  
  2492.  
  2493.  
  2494.  
  2495.  
  2496.  
  2497.  
  2498.  
  2499.  
  2500.  
  2501.  
  2502.  
  2503.  
  2504.  
  2505.  
  2506.  
  2507.  
  2508.  
  2509.  
  2510.  
  2511.  
  2512.  
  2513.  
  2514.  
  2515.  
  2516.  
  2517.  
  2518.  
  2519.  
  2520. mxm.library/DisableWindow               mxm.library/DisableWindow
  2521.  
  2522.  
  2523.    NAME  
  2524.        DisableWindow  - Disable all gadgets of a window and set a
  2525.        Zzz mouse pointer.  
  2526.  
  2527.    SYNOPSIS 
  2528.        Success = DisableWindow(Window)       
  2529.  
  2530.    FUNCTION  
  2531.        This  function  disables all custom gadgets to be found in
  2532.        the window and sets a Zzz mouse pointer.  
  2533.  
  2534.    INPUTS  
  2535.        Window - 
  2536.            Pointer to a Window-structure.  
  2537.  
  2538.    RESULTS  
  2539.        Success - 
  2540.            Boolean, TRUE if window was disabled.  
  2541.  
  2542.    BUGS  
  2543.        You  MUST not remove or add Gadgets to the window after it
  2544.        has been disabled, or EnableWindow() will panic.  
  2545.  
  2546.    SEE ALSO 
  2547.        mxm.library/EnableWindow()         
  2548.  
  2549.  
  2550.  
  2551.  
  2552.  
  2553.  
  2554.  
  2555.  
  2556.  
  2557.  
  2558.  
  2559.  
  2560.  
  2561.  
  2562.  
  2563.  
  2564.  
  2565.  
  2566.  
  2567.  
  2568.  
  2569.  
  2570.  
  2571.  
  2572.  
  2573.  
  2574.  
  2575.  
  2576.  
  2577.  
  2578.  
  2579.